home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / frame.n < prev    next >
Text File  |  1994-09-20  |  9KB  |  321 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\"
  22. '\" $Header: /user6/ouster/wish/man/RCS/frame.n,v 1.9 93/04/01 09:52:40 ouster Exp $ SPRITE (Berkeley)
  23. '/" 
  24. .\" The definitions below are for supplemental macros used in Tcl/Tk
  25. .\" manual entries.
  26. .\"
  27. .\" .HS name section [date [version]]
  28. .\"    Replacement for .TH in other man pages.  See below for valid
  29. .\"    section names.
  30. .\"
  31. .\" .AP type name in/out [indent]
  32. .\"    Start paragraph describing an argument to a library procedure.
  33. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  34. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  35. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  36. .\"    needed;  use .AS below instead)
  37. .\"
  38. .\" .AS [type [name]]
  39. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  40. .\"    name are examples of largest possible arguments that will be passed
  41. .\"    to .AP later.  If args are omitted, default tab stops are used.
  42. .\"
  43. .\" .BS
  44. .\"    Start box enclosure.  From here until next .BE, everything will be
  45. .\"    enclosed in one large box.
  46. .\"
  47. .\" .BE
  48. .\"    End of box enclosure.
  49. .\"
  50. .\" .VS
  51. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  52. .\"    of man pages.
  53. .\"
  54. .\" .VE
  55. .\"    End of vertical sidebar.
  56. .\"
  57. .\" .DS
  58. .\"    Begin an indented unfilled display.
  59. .\"
  60. .\" .DE
  61. .\"    End of indented unfilled display.
  62. .\"
  63. '\"    # Heading for Tcl/Tk man pages
  64. .de HS
  65. .ds ^3 \\0
  66. .if !"\\$3"" .ds ^3 \\$3
  67. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  68. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  69. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  70. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  71. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  72. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  73. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  74. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  75. .if t .wh -1.3i ^B
  76. .nr ^l \\n(.l
  77. .ad b
  78. ..
  79. '\"    # Start an argument description
  80. .de AP
  81. .ie !"\\$4"" .TP \\$4
  82. .el \{\
  83. .   ie !"\\$2"" .TP \\n()Cu
  84. .   el          .TP 15
  85. .\}
  86. .ie !"\\$3"" \{\
  87. .ta \\n()Au \\n()Bu
  88. \&\\$1    \\fI\\$2\\fP    (\\$3)
  89. .\".b
  90. .\}
  91. .el \{\
  92. .br
  93. .ie !"\\$2"" \{\
  94. \&\\$1    \\fI\\$2\\fP
  95. .\}
  96. .el \{\
  97. \&\\fI\\$1\\fP
  98. .\}
  99. .\}
  100. ..
  101. '\"    # define tabbing values for .AP
  102. .de AS
  103. .nr )A 10n
  104. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  105. .nr )B \\n()Au+15n
  106. .\"
  107. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  108. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  109. ..
  110. '\"    # BS - start boxed text
  111. '\"    # ^y = starting y location
  112. '\"    # ^b = 1
  113. .de BS
  114. .br
  115. .mk ^y
  116. .nr ^b 1u
  117. .if n .nf
  118. .if n .ti 0
  119. .if n \l'\\n(.lu\(ul'
  120. .if n .fi
  121. ..
  122. '\"    # BE - end boxed text (draw box now)
  123. .de BE
  124. .nf
  125. .ti 0
  126. .mk ^t
  127. .ie n \l'\\n(^lu\(ul'
  128. .el \{\
  129. .\"    Draw four-sided box normally, but don't draw top of
  130. .\"    box if the box started on an earlier page.
  131. .ie !\\n(^b-1 \{\
  132. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  133. .\}
  134. .el \}\
  135. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  136. .\}
  137. .\}
  138. .fi
  139. .br
  140. .nr ^b 0
  141. ..
  142. '\"    # VS - start vertical sidebar
  143. '\"    # ^Y = starting y location
  144. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  145. .de VS
  146. .mk ^Y
  147. .ie n 'mc \s12\(br\s0
  148. .el .nr ^v 1u
  149. ..
  150. '\"    # VE - end of vertical sidebar
  151. .de VE
  152. .ie n 'mc
  153. .el \{\
  154. .ev 2
  155. .nf
  156. .ti 0
  157. .mk ^t
  158. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  159. .sp -1
  160. .fi
  161. .ev
  162. .\}
  163. .nr ^v 0
  164. ..
  165. '\"    # Special macro to handle page bottom:  finish off current
  166. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  167. '\"    # page bottom macro.
  168. .de ^B
  169. .ev 2
  170. 'ti 0
  171. 'nf
  172. .mk ^t
  173. .if \\n(^b \{\
  174. .\"    Draw three-sided box if this is the box's first page,
  175. .\"    draw two sides but no top otherwise.
  176. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  178. .\}
  179. .if \\n(^v \{\
  180. .nr ^x \\n(^tu+1v-\\n(^Yu
  181. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  182. .\}
  183. .bp
  184. 'fi
  185. .ev
  186. .if \\n(^b \{\
  187. .mk ^y
  188. .nr ^b 2
  189. .\}
  190. .if \\n(^v \{\
  191. .mk ^Y
  192. .\}
  193. ..
  194. '\"    # DS - begin display
  195. .de DS
  196. .RS
  197. .nf
  198. .sp
  199. ..
  200. '\"    # DE - end display
  201. .de DE
  202. .fi
  203. .RE
  204. .sp .5
  205. ..
  206. .HS frame tk
  207. .BS
  208. '\" Note:  do not modify the .SH NAME line immediately below!
  209. .SH NAME
  210. frame \- Create and manipulate frame widgets
  211. .SH SYNOPSIS
  212. \fBframe\fI \fIpathName \fR?\fB\-class \fIclassName\fR? ?\fIoptions\fR?
  213. .SH "STANDARD OPTIONS"
  214. .LP
  215. .nf
  216. .ta 4c 8c 12c
  217. .VS
  218. \fBbackground\fR    \fBcursor\fR    \fBrelief\fR
  219. .VE
  220. \fBborderWidth\fR    \fBgeometry\fR
  221. .fi
  222. .LP
  223. See the ``options'' manual entry for details on the standard options.
  224. .SH "WIDGET-SPECIFIC OPTIONS"
  225. .LP
  226. .nf
  227. .VS
  228. Name:    \fBheight\fR
  229. Class:    \fBHeight\fR
  230. Command-Line Switch:    \fB\-height\fR
  231. .fi
  232. .IP
  233. Specifies the desired height for the window in any of the forms
  234. acceptable to \fBTk_GetPixels\fR.
  235. This option is only used if the \fB\-geometry\fR option is
  236. unspecified.
  237. If this option is less than or equal to zero (and \fB\-geometry\fR
  238. is not specified) then the window will not request any size at
  239. all.
  240. .LP
  241. .nf
  242. Name:    \fBwidth\fR
  243. Class:    \fBWidth\fR
  244. Command-Line Switch:    \fB\-width\fR
  245. .fi
  246. .IP
  247. Specifies the desired width for the window in any of the forms
  248. acceptable to \fBTk_GetPixels\fR.
  249. This option is only used if the \fB\-geometry\fR option is
  250. unspecified.
  251. If this option is less than or equal to zero (and \fB\-geometry\fR
  252. is not specified) then the window will not request any size at
  253. all.
  254. .VE
  255. .BE
  256.  
  257. .SH DESCRIPTION
  258. .PP
  259. The \fBframe\fR command creates a new window (given by the
  260. \fIpathName\fR argument) and makes it into a frame widget.
  261. Additional
  262. options, described above, may be specified on the command line
  263. or in the option database
  264. to configure aspects of the frame such as its background color
  265. and relief.  The \fBframe\fR command returns the
  266. path name of the new window.
  267. .PP
  268. A frame is a simple widget.  Its primary purpose is to act as a
  269. spacer or container for complex window layouts.  The only features
  270. of a frame are its background color and an optional 3-D border to make the
  271. frame appear raised or sunken.
  272. .PP
  273. In addition to the standard options listed above, a \fB\-class\fR
  274. option may be specified on the command line.  If it is specified, then
  275. the new widget's class will be set to \fIclassName\fR instead of
  276. \fBFrame\fR.  Changing the class of a frame widget may be useful
  277. in order to use a special class name in database options referring
  278. to this widget and its children.  Note:  \fB\-class\fR is handled
  279. differently than other command-line options and cannot be specified
  280. using the option database (it has to be processed
  281. before the other options are even looked up, since the new class
  282. name will affect the lookup of the other options).  In addition,
  283. the \fB\-class\fR option may not be queried or changed using the
  284. \fBconfig\fR command described below.
  285.  
  286. .SH "WIDGET COMMAND"
  287. .PP
  288. The \fBframe\fR command creates a new Tcl command whose
  289. name is the same as the path name of the frame's window.  This
  290. command may be used to invoke various
  291. operations on the widget.  It has the following general form:
  292. .DS C
  293. \fIpathName option \fR?\fIarg arg ...\fR?
  294. .DE
  295. \fIPathName\fR is the name of the command, which is the same as
  296. the frame widget's path name.  \fIOption\fR and the \fIarg\fRs
  297. determine the exact behavior of the command.  The following
  298. commands are possible for frame widgets:
  299. .TP
  300. \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
  301. Query or modify the configuration options of the widget.
  302. If no \fIoption\fR is specified, returns a list describing all of
  303. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  304. information on the format of this list).  If \fIoption\fR is specified
  305. with no \fIvalue\fR, then the command returns a list describing the
  306. one named option (this list will be identical to the corresponding
  307. sublist of the value returned if no \fIoption\fR is specified).  If
  308. one or more \fIoption\-value\fR pairs are specified, then the command
  309. modifies the given widget option(s) to have the given value(s);  in
  310. this case the command returns an empty string.
  311. \fIOption\fR may have any of the values accepted by the \fBframe\fR
  312. command.
  313.  
  314. .SH BINDINGS
  315. .PP
  316. When a new frame is created, it has no default event bindings:
  317. frames are not intended to be interactive.
  318.  
  319. .SH KEYWORDS
  320. frame, widget
  321.